adTempus API
ArcanaDevelopment.adTempus.Client Namespace / DataContext Class / GetSecurityLogins Method / GetSecurityLogins(LoginType[],ObjectFetchOptions,Boolean,Int32,Boolean) Method
The type(s) of logins to return
Options that control the fetch operation
Determines whether permissions are returned with the entities
The maximum number of records to retrieve in one call. See Remarks.
Indicates whether to fetch the first page or continue paging. See Remarks.


In This Topic
    GetSecurityLogins(LoginType[],ObjectFetchOptions,Boolean,Int32,Boolean) Method
    In This Topic
    Gets all security logins for the specified type(s), with paging
    Syntax
    'Declaration
     
    
    <NotNullAttribute()>
    Public Overloads Function GetSecurityLogins( _
       ByVal types() As LoginType, _
       ByVal fetchOptions As ObjectFetchOptions, _
       ByVal includePermissions As Boolean, _
       ByVal pageSize As Integer, _
       ByRef restartPaging As Boolean _
    ) As SecurityLoginCollection

    Parameters

    types
    The type(s) of logins to return
    fetchOptions
    Options that control the fetch operation
    includePermissions
    Determines whether permissions are returned with the entities
    pageSize
    The maximum number of records to retrieve in one call. See Remarks.
    restartPaging
    Indicates whether to fetch the first page or continue paging. See Remarks.

    Return Value

    All security logins of the specified type(s)
    Remarks

    The caller must have permission to administer security on the adTempus server.

    By default includePermissions is false and this method does not return the permissions associated with the entities (to save processing overhead). This is appropriate if you just want to display the names of the entities. If you subsequently need the permission for an entity, calling SecurityEntity.GetPermissions will fetch the permissions from the server.

    If you know in advance that you will want the permissions for all of the returned objects, it is more efficient to set includePermissions to true to return them all in a single call.

    Paging

    This method supports paged retrieval for scenarios where the amount of data returned by a fetch of all objects is not feasible for performance reasons.

    To begin a paged fetch, set the pageSize to the desired number of records per page, and set restartPaging to true to start the fetch from the first record. On return, restartPaging will be set to false if there are more records to return. Continue to call the method with restartPaging set to false until it is true on return. At this point, all available records have been returned.

    Note that there is no way to specify the page at which the retrieval should begin; fetching is sequential only.

    See Also